Package com.cisco.pt.ipc.sim
Interface STPProcess
- All Known Implementing Classes:
STPProcessImpl
Information provided by the PKI file:
\class StpProcess
\brief StpProcess handles and manipulates STP processes.
\example network().getDevice("Switch0").getProcess("StpMainProcess").getStpProcess(1)
- Author:
- Auto-generated
-
Method Summary
Modifier and TypeMethodDescriptionintInformation provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:Methods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSessionMethods inherited from interface com.cisco.pt.ipc.sim.Process
getOwnerDevice
-
Method Details
-
getSwitchPriority
int getSwitchPriority()Information provided by the PKI file:
\brief Returns the priority. \return int, the priority.- Returns:
- int Returns a int
-
getRootBridgeId
String getRootBridgeId()Information provided by the PKI file:
\brief Returns the root bridge ID. \return string, the root bridge ID.- Returns:
- String Returns a String
-
getPortCount
int getPortCount()Information provided by the PKI file:
\brief Returns the number of ports in the STP process. \return int, the number of ports in the STP process.- Returns:
- int Returns a int
-
isRootBridge
boolean isRootBridge()Information provided by the PKI file:
\brief Returns true if this switch is the root bridge, otherwise false. \return bool, true if this switch is the root bridge, otherwise false.- Returns:
- boolean Returns a boolean
-
getSwitchId
String getSwitchId()Information provided by the PKI file:
\brief Returns the ID for this switch. \return string, the ID for this switch.- Returns:
- String Returns a String
-
hasPort
Information provided by the PKI file:
\brief Returns true if the specified port is in this STP process, otherwise false. \param portName, portName can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0 \return bool, true if the specified port is in this STP process, otherwise false.- Parameters:
portName- Takes in a parameter of portName- Returns:
- boolean Returns a boolean
-
getRootPort
SwitchPort getRootPort()Information provided by the PKI file:
\brief Returns the root port in this STP process. \return SwitchPort, the SwitchPort object.- Returns:
- SwitchPort Returns a SwitchPort
-
getRootPathCost
int getRootPathCost()Information provided by the PKI file:
\brief Returns the root path cost. \return int, the root path cost.- Returns:
- int Returns a int
-